Add :Augment help [command] subcommand#67
Merged
mgmonteleone merged 1 commit intoJun 9, 2026
Merged
Conversation
Add a `help` subcommand that lists all available Augment commands with a short description, and shows more detailed inline help for a specific command via `:Augment help <command>`. The deprecated `enable`/`disable` commands are listed and point users to `g:augment_disable_completions`. The `help` command is available even when the plugin fails to initialize, matching the existing behavior of `status` and `log`. Documentation in `doc/augment.txt`, the README command list, and the changelog are updated accordingly. Fixes #32
mgmonteleone
deleted the
augmentstaging1-css-904-gh-32-add-augment-help-command-to-list-available-commands
branch
This was referenced Jun 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
:Augment help [command]subcommand, as requested in #32.:Augment helplists every available command with a one-line description.:Augment help <command>shows more detailed inline help for that command (e.g.:Augment help chat). An unknown command produces a friendly error pointing back to:Augment help.enable/disablecommands are listed and clearly marked(deprecated), pointing users to theg:augment_disable_completionsoption.statusandlog,helpworks even when the plugin fails to initialize.augment#CommandCompleteautomatically picks uphelp(it returns the keys of the command-handler dict), so tab completion includes it.Implementation
s:CommandHelp(range, args)handler and an ordereds:command_helpdata structure inautoload/augment.vim, following the existings:CommandXxxstyle and usingechohlhighlight groups.helpadded to thes:command_handlersdict and to the pre-init allow-list inaugment#Command.Docs
doc/augment.txt: documented the new:Augment helpcommand.README.md: addedhelpto the command list.CHANGELOG.md: added an Unreleased entry.Testing
The repository has no test framework, so this was verified manually with headless
vim -esandnvim --headlesssmoke checks::Augment helplists all commands (deprecated ones marked).:Augment help chat/:Augment help enableshow inline detail.:Augment help CHAT) works.:Augment help bogusshows the friendly unknown-command error.:Augment helpworks with the plugin in an uninitialized state.augment#CommandCompleteincludeshelp.Fixes #32